home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / search33.zip / SEARCH.DOC < prev    next >
Text File  |  1992-12-25  |  23KB  |  500 lines
  1.  
  2.  
  3.                               WORD  SEARCH
  4.  
  5.                                   v3.3
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                             (404) 256-9525
  13.  
  14.  
  15.  
  16.  
  17.                                 OVERVIEW
  18.                                 ________
  19.  
  20.  
  21.    Word Search is a computerized adaptation of the type of puzzles normally
  22.    found in puzzle books, newspapers and magazines. Given a list of words,
  23.    you must find them in the letter grid. They are hidden horizontally,
  24.    vertically, diagonally, in both normal and reverse order spelling.
  25.  
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all SEARCH files
  43.  
  44.       2) Unzip SEARCHxx.ZIP into the the above directory
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied SEARCH.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First name
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55.             00000000                 Registration Number
  56.  
  57. |-----------------------------------------------------------------------------|
  58. | READ!     1                        CommPort  \ These 2 lines are required   |
  59. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  60. |-----------------------------------------------------------------------------|
  61.  
  62.     !   #   2                        Maximum # of Games per day
  63.                                      (Sysop gets 99 in Registered version ONLY!)
  64.  
  65.         #   0                        Max # of days a caller can make up, during
  66.                                      calls in one day. 0=Disable Make-up Option
  67.                                      Maximum value = 27, Minimum value = 1
  68.  
  69.         #   NONE                     Drive:\Path\Filename to contain the
  70.                                      Top Score Bulletin or enter NONE
  71.                                      for NO Bulletin creation.
  72.  
  73.         #   NONE                     Drive:\Path\Filename to contain the
  74.                                      Top Score Bulletin (Color) or enter NONE
  75.                                      for NO Bulletin creation.
  76.  
  77.         #   NONE                     Drive:\Path\Filename to contain the
  78.                                      Hall of Fame Bulletin or enter NONE
  79.                                      for NO Bulletin creation.
  80.  
  81.         #   NONE                     Drive:\Path\Filename to contain the
  82.                                      Hall of Fame Bulletin (Color) or enter NONE
  83.                                      for NO Bulletin creation.
  84.  
  85.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  86.                                      2 = Display ADOPT-A-DOOR message
  87.  
  88.         #   2                        Keyboard timeout value in Minutes
  89.  
  90.  
  91.         #   2                        Max. time to play each word (1-4 Minutes)
  92.  
  93.         #   5                        Number of words to hide in the grid(1-9)
  94.  
  95.     !   #   0                        Time Allowed in Door
  96.                                      (Sysop = Time Remaining - REG. VERSION)
  97.  
  98.         #   N                        Automatic game reset at end of month:
  99.                                        Y = Yes enable autoreset
  100.                                        N = Keep accumulating scores
  101.  
  102.         #   Y                        Y = Allow Sysop to have 999 games
  103.                                      N = Do Not Allow Sysop 999 games
  104.  
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  107.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  108.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  109.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  110.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  111.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  112.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  113.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.  
  116.     @   #   XXXX/YYYY                 Blackout Range  From/To
  117.     @   #   XXXX/YYYY                 Blackout Range  From/To
  118.     @   #   XXXX/YYYY                 Blackout Range  From/To
  119.     @   #   XXXX/YYYY                 Blackout Range  From/To
  120.     @   #   XXXX/YYYY                 Blackout Range  From/To
  121.           ** = Replace with ONE of the following:
  122.  
  123. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  124. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  125. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  126.                                    (Note:DOOR.SYS must be in SAME directory)
  127. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  128. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  129. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  130. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  131. C:\BBS\CHAIN.TXT                <- For WWIV systems
  132. C:\BBS\GTUSER.BBS               <- For GT Power
  133.                                    * if using this option you must put the
  134.                                      ComPort # on line 5 and the Node # on
  135.                                      line 6 of the configuration file
  136.  
  137.  
  138.            # = Requires registration to change to a different value.
  139.            ! = See "Plays Per DAY/DOOR Time" Below
  140.            @ = See "Blackout Periods" Below
  141.  
  142.  
  143.                NOTE: There are NO Blank Lines in the Config File!!
  144.  
  145.  
  146.       4) Create a batch file or modify the PAIR3 file supplied. A
  147.          description of this file follows:
  148.  
  149.             ECHO off
  150.             cd\PCB\DOORS\SEARCH       Location of Search files
  151.             SEARCH SEARCH.CFG         EXE filename and CNF filename (Name
  152.                                       used in creating file in #3 above)
  153.             CD\PCB
  154.             BOARD
  155.  
  156.  
  157.        5) When running in more than one node, be sure to supply a
  158.           different configuration name for each node (your choice of name).
  159.  
  160.        6) If running with Fossil-Based multi-port boards add
  161.            /FD to the line containing the CFG name as follows:
  162.  
  163.                           SEARCH SEARCH.CFG /FD
  164.  
  165.  
  166.  
  167.                MAKE-UP DAYS (Registered version only)
  168.                --------------------------------------
  169.  
  170. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  171. during the current month and prior to the current call. You control whether
  172. to allow this option, as well as the number of days the caller can make up, on
  173. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  174. configuration file, turns the option OFF, any other value (up to a max of 27)
  175. turns the option ON and dictates the number of days the caller can make up.
  176.  
  177.  
  178. NOTE:      The number of games per day is calculated as follows...
  179.  
  180.            Games Allowed per day x Number of makeup days.
  181.  
  182. Example:   Games Allowed per day = 2
  183.            Max # of makeup days  = 4
  184.  
  185. If a caller logs in on 5/8/92 and this is their first call of the month, they
  186. would have a potential of 16 games to makeup and bring them current
  187. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  188. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  189. (games allowed * max # of makeup days).
  190.  
  191.  
  192.  
  193.              HALL OF FAME BULLETINS (Registered version only)
  194.              ------------------------------------------------
  195.  
  196. The program will automatically reset the game when the first caller of the
  197. month plays the game. The score file will be cleared and a set of Hall of Fame
  198. bulletin files will be created. The files will be called SUNHOF.ASC and
  199. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  200. directory as the SEARCH.EXE file. You are responsible for COPYING the files to
  201. your bulletin area and renaming to a filename of your choice.
  202.  
  203. WARNING: The HOF files are cumulative files. That means they are read in each
  204.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  205.          the record of prior months winners!!!!
  206.  
  207.  
  208.  
  209.                           BLACKOUT PERIODS
  210.                           ________________
  211.  
  212.       Use the Blackout ranges option to define up to 5 time periods during
  213.       which you DO NOT want the Door to be played. If a caller tries to access
  214.       the Door during the Blackout period, they will be shown a message that
  215.       contains ALL the Blackout periods you have defined, and to try the Door
  216.       at a later time.
  217.  
  218.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  219.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  220.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  221.  
  222.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  223.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  224.                    a Blackout range.
  225.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  226.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  227.  
  228.  
  229.                           PLAYS Per DAY/DOOR Time
  230.                           _______________________
  231.  
  232.       Plays Per Day and Door Time can be controlled several ways:
  233.  
  234.       (1) You can use the Games Per Day, singular option, in the config
  235.           file above. This option, will affect ALL callers whose Security
  236.           Level is NOT defined in any of the 10 optional Security Level/
  237.           Plays Per Day entries in the config file.
  238.  
  239.       (2) You can use the Door Time, singular option, in the config file
  240.           above. This option, will affect ALL callers whose Security
  241.           Level is NOT defined in any of the 10 optional Security Level/
  242.           Plays Per Day/Door Time entries in the config file.
  243.  
  244.       (3) You can restrict the number of games a specific Security Level
  245.           will be allowed to play per day or REWARD specific Levels with
  246.           more Plays Per Day.
  247.  
  248.           Likewise, you can restrict the Play time for a specific Security
  249.           Level or REWARD specific Levels with more Door Time.
  250.  
  251.           These options are handled by the use of the 10 config
  252.           entries (000=00/00).
  253.  
  254.           The format of each entry is as follows:
  255.  
  256.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  257.                      where =  is a constant and MUST be included
  258.                      where YY is the # of games per day (must be 2 digits)
  259.                      where / is a constant and MUST be included
  260.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  261.  
  262.           If the callers Security Level is NOT defined, his/her Plays Per
  263.           Day and Door Time will be controlled by the values in items
  264.           (1) and (2), above, respectively..
  265.  
  266.           You may define up to 10 Security Levels. All unused entries must
  267.           be defined as   000=00/00
  268.         --------------------------------------------------------------------
  269.           Example: Suppose you had 3 Security Levels defined on your BBS as
  270.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  271.           wanted to set Plays Per Day as :     Subscriber=5
  272.                                            Visiting Sysop=2
  273.                                                   CoSysop=3
  274.                                                    Friend=10
  275.  
  276.           and Door Time as follows:     Subscriber=30 minutes
  277.                                     Visiting Sysop=20 minutes
  278.                                            CoSysop=10 minutes
  279.                                             Friend=remaining call time
  280.  
  281.  
  282.           You would set the Individual "Games per Day" config entry to 1 and
  283.           the individual "Door Time" to 5 minutes (these would be the
  284.           default number of games and default Time for all Security Levels
  285.           other than 20,30 or 40... make them any number you want). Next you
  286.           would replace 4 of the Security Level entries as :  020=05/30
  287.                                                               030=02/20
  288.                                                               040=03/10
  289.                                                               090=10/0
  290.  
  291.  
  292.  
  293.  
  294.  
  295.                                WORD FILE
  296.                                _________
  297.  
  298.      In the unregistered version of Word Search there is an interenal word
  299.      list, containing 15 words. When you register the door, the program will
  300.      access the SEARCH.QUE file, which will initially contain 200 words. You
  301.      are free to create your own list or modify the supplied list (using any
  302.      word processor or editor). The length of each word must not exceed 9
  303.      characters and the name of the file must be SEARCH.QUE.
  304.  
  305.      The number of puzzles contained in the file is important. There must be
  306.      enough puzzles in the file equal to or greater than the following formula:
  307.  
  308.               MAXIMUM GAMES per DAY  x  NUMBER WORDS to HIDE + 10
  309.  
  310.      For example: if your configuration file was setup to allow the caller to
  311.      play 5 games per day and to hide 9 words, then the minimum number of
  312.      words you would have to have in the SEARCH.QUE file would be 55.
  313.  
  314.      NOTE: This also applies to the Sysop games per day. In order to play the
  315.      maximum 99 games per day, with 9 hidden words per game, you would need
  316.      901 words in the SEARCH.QUE file (which is also the limit for the file).
  317.  
  318.  
  319.  
  320.                         NON-STANDARD COM SUPPORT
  321.                         ________________________
  322.  
  323.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  324.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  325.       number after the configuration filename. Let's assume your Door is
  326.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  327.       passed to your Door would be:
  328.  
  329.                             FOOBAR FOOBAR.CFG /5
  330.  
  331.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  332.       normally used with COM1. No /x parameter is needed for the standard
  333.       IRQ's.
  334.  
  335.       As an alternative, you may use an environmental variable on the command
  336.       line. To use the variable (following the example above), place a
  337.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  338.       different IRQ number for each node). The command line would now look
  339.       like this:
  340.  
  341.                           FOOBAR FOOBAR.CFG /%IRQ%
  342.  
  343.       This, in combination with the use of the environmental variables
  344.       described in the MULTI-NODE SETUP section will allow you to use one
  345.       batch file and one config file to run this door on all nodes.
  346.  
  347.  
  348.  
  349.  
  350.                            MULTI-NODE SETUP
  351.                            ________________
  352.  
  353.       All Sunrise Doors are Multi-Node capable. Each node must have the
  354.       ability to access a configuration file which will have its own system
  355.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  356.       line. There are 2 ways to accomplish this:
  357.  
  358.       (1) Create a separate configuration file for each node. The only
  359.           difference between each file would be the location of the system
  360.           file for that particular node. For example, on my system there are 2
  361.           nodes and the first line of the config files would look like this:
  362.  
  363.                         NODE1:  H:\PCB1\DOOR.SYS
  364.                         NODE2:  H:\PCB2\DOOR.SYS
  365.  
  366.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  367.  
  368.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  369.           the following PCBoard environmental variables:
  370.  
  371.                  PCBDIR    (Directory containing the System file)
  372.                  PCBDRIVE  (Drive containing the System file)
  373.  
  374.           Thus, the first line of the SINGLE configuration file, for this Door
  375.           would look like this:
  376.  
  377.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  378.  
  379.       NOTE: This option, as described, assumes that you are running PCBoard
  380.             14.5a software. The environmental variables are automatically
  381.             created by the software for each node.
  382.  
  383.             HOWEVER, if you are running other BBS software you should be able
  384.             to set the variables EXACTLY as described below, for EACH node
  385.             (more than likely in each batch file you use to bring up EACH node):
  386.  
  387.                             PCBDRIVE=C:
  388.                             ^^^^^^^^^
  389.                             PCBDIR=\NODE2
  390.                             ^^^^^^^^
  391.  
  392.             Info with a carat (^) under it, MUST be typed as is. The rest
  393.             depends on your naming conventions.
  394.  
  395.             This, in combination with the use of the optional environmental
  396.             variable described in the NON-STANDARD COM SUPPORT section, will
  397.             allow you to use one batch file and one config file to run this
  398.             door on all nodes.
  399.  
  400.  
  401.  
  402.  
  403.                                ADOPT-A-DOOR
  404.                                ____________
  405.  
  406.     Having been a Sysop for a number of years, I have had my share of problems
  407.     and frustrations getting financial support for my board's upkeep. A fellow
  408.     Sysop left a message on my board, not long ago, about a concept that was
  409.     being used by several boards around the country.
  410.  
  411.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  412.     would be the same as sending in a donation, only this way it is earmarked
  413.     for registering a particular door. In a way, the user feels he/she is
  414.     "getting something in return". As a Door author I have decided to build
  415.     this concept into each of my Door programs. The concept replaces the
  416.     usual message "tell the Sysop to register this Door" we find in most
  417.     doors.
  418.  
  419.     If the Door is unregisterd then a message appears on the opening screen
  420.     to that effect. After finishing or suspending a game, a message screen
  421.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  422.     caller to contact the Sysop to find out if there is any further details
  423.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  424.     time, etc to callers that ADOPT-A-DOOR.
  425.  
  426.     If the Door has been registered, either by the Sysop or other callers,
  427.     the names of those contributors will be displayed in the closing screen.
  428.  
  429.     NOTE: If you want to display the names of the callers that contributed
  430.           to registering the Door, you must create an ASCII file called
  431.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  432.           the name(s) of the contributors (one on each line, maximum of 5
  433.           entries, each a maximum of 30 characters long). This file must be
  434.           saved, in ASCII format, and placed in the Door directory.
  435.  
  436.  
  437.  
  438.                               LEGALITIES
  439.                               __________
  440.  
  441.  
  442.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  443.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  444.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  445.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  446.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  447.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  448.       OR BREACH OF ANY WARRANTY.
  449.  
  450.  
  451.  
  452.  
  453.  
  454.                              DISTRIBUTION
  455.                              ____________
  456.  
  457.    You may make this file available for downloading from your BBS or you may
  458.    upload it to any BBS of your choice, provided that you do not make any
  459.    changes to the contents of the archive (ZIP file). The archive and its
  460.    individual contents may not be used by any service that charges any money
  461.    whatsoever, without the written permission of the author.
  462.  
  463.  
  464.  
  465.  
  466.  
  467.                              REGISTRATION
  468.                              ____________
  469.  
  470.    Registration and the subsequent insertion of the registration number into
  471.    your configuation file, allows for the display of your BBS name on the
  472.    opening and closing screen as well as the reduction of a delay built into
  473.    the opening screen display along with the ability to change certain values
  474.    in the configuration file.
  475.  
  476.    To register your copy of SEARCH, please fill out the registration form
  477.    (REGISTER.FRM) and mail it along with the registration fee to
  478.    the name and address on the form.
  479.  
  480.    Be sure to use the proper upper/lower case when filling in your name and
  481.    BBS name, as they MUST match the way you entered them in the configuration
  482.    file.             ^^^^
  483.  
  484.    Based upon information supplied on the registration form, I will pre-
  485.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  486.    up your registration number.
  487.  
  488.  
  489.  
  490.                                  MISC
  491.                                  ____
  492.  
  493.    The latest version of WORD SEARCH and other fine SUNRISE DOOR programs
  494.    are always available for download from SUNRISE-80 BBS.
  495.  
  496.    Remember, should you have any problems, questions or suggestions, be sure
  497.    to drop me a message on Sunrise-80 or you can reach me through the
  498.    RIME (BBS Doors, Sysops, PCBHints), SmartNet, FIDOnet 1:133/410
  499.  
  500.